home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / string.n < prev    next >
Encoding:
Text File  |  1994-09-20  |  9.2 KB  |  313 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/string.n,v 1.1 93/06/16 16:48:24 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS string tcl
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. string \- Manipulate strings
  210. .SH SYNOPSIS
  211. \fBstring \fIoption arg \fR?\fIarg ...?\fR
  212. .BE
  213.  
  214. .SH DESCRIPTION
  215. .PP
  216. Performs one of several string operations, depending on \fIoption\fR.
  217. The legal \fIoption\fRs (which may be abbreviated) are:
  218. .TP
  219. \fBstring compare \fIstring1 string2\fR
  220. Perform a character-by-character comparison of strings \fIstring1\fR and
  221. \fIstring2\fR in the same way as the C \fBstrcmp\fR procedure.  Return
  222. \-1, 0, or 1, depending on whether \fIstring1\fR is lexicographically
  223. less than, equal to, or greater than \fIstring2\fR.
  224. .TP
  225. \fBstring first \fIstring1 string2\fR
  226. Search \fIstring2\fR for a sequence of characters that exactly match
  227. the characters in \fIstring1\fR.  If found, return the index of the
  228. first character in the first such match within \fIstring2\fR.  If not
  229. found, return \-1.
  230. .TP
  231. \fBstring index \fIstring charIndex\fR
  232. Returns the \fIcharIndex\fR'th character of the \fIstring\fR
  233. argument.  A \fIcharIndex\fR of 0 corresponds to the first
  234. character of the string.
  235. If \fIcharIndex\fR is less than 0 or greater than
  236. or equal to the length of the string then an empty string is
  237. returned.
  238. .TP
  239. \fBstring last \fIstring1 string2\fR
  240. Search \fIstring2\fR for a sequence of characters that exactly match
  241. the characters in \fIstring1\fR.  If found, return the index of the
  242. first character in the last such match within \fIstring2\fR.  If there
  243. is no match, then return \-1.
  244. .TP
  245. \fBstring length \fIstring\fR
  246. Returns a decimal string giving the number of characters in \fIstring\fR.
  247. .TP
  248. \fBstring match \fIpattern\fR \fIstring\fR
  249. See if \fIpattern\fR matches \fIstring\fR; return 1 if it does, 0
  250. if it doesn't.  Matching is done in a fashion similar to that
  251. used by the C-shell.  For the two strings to match, their contents
  252. must be identical except that the following special sequences
  253. may appear in \fIpattern\fR:
  254. .RS
  255. .IP \fB*\fR 10
  256. Matches any sequence of characters in \fIstring\fR,
  257. including a null string.
  258. .IP \fB?\fR 10
  259. Matches any single character in \fIstring\fR.
  260. .IP \fB[\fIchars\fB]\fR 10
  261. Matches any character in the set given by \fIchars\fR.  If a sequence
  262. of the form
  263. \fIx\fB\-\fIy\fR appears in \fIchars\fR, then any character
  264. between \fIx\fR and \fIy\fR, inclusive, will match.
  265. .IP \fB\e\fIx\fR 10
  266. Matches the single character \fIx\fR.  This provides a way of
  267. avoiding the special interpretation of the characters
  268. \fB*?[]\e\fR in \fIpattern\fR.
  269. .RE
  270. .TP
  271. \fBstring range \fIstring first last\fR
  272. Returns a range of consecutive characters from \fIstring\fR, starting
  273. with the character whose index is \fIfirst\fR and ending with the
  274. character whose index is \fIlast\fR.  An index of 0 refers to the
  275. first character of the string.  \fILast\fR may be \fBend\fR (or any
  276. abbreviation of it) to refer to the last character of the string.
  277. If \fIfirst\fR is less than zero then it is treated as if it were zero, and
  278. if \fIlast\fR is greater than or equal to the length of the string then
  279. it is treated as if it were \fBend\fR.  If \fIfirst\fR is greater than
  280. \fIlast\fR then an empty string is returned.
  281. .TP
  282. \fBstring tolower \fIstring\fR
  283. Returns a value equal to \fIstring\fR except that all upper case
  284. letters have been converted to lower case.
  285. .TP
  286. \fBstring toupper \fIstring\fR
  287. Returns a value equal to \fIstring\fR except that all lower case
  288. letters have been converted to upper case.
  289. .TP
  290. \fBstring trim \fIstring\fR ?\fIchars\fR?
  291. Returns a value equal to \fIstring\fR except that any leading
  292. or trailing characters from the set given by \fIchars\fR are
  293. removed.
  294. If \fIchars\fR is not specified then white space is removed
  295. (spaces, tabs, newlines, and carriage returns).
  296. .TP
  297. \fBstring trimleft \fIstring\fR ?\fIchars\fR?
  298. Returns a value equal to \fIstring\fR except that any
  299. leading characters from the set given by \fIchars\fR are
  300. removed.
  301. If \fIchars\fR is not specified then white space is removed
  302. (spaces, tabs, newlines, and carriage returns).
  303. .TP
  304. \fBstring trimright \fIstring\fR ?\fIchars\fR?
  305. Returns a value equal to \fIstring\fR except that any
  306. trailing characters from the set given by \fIchars\fR are
  307. removed.
  308. If \fIchars\fR is not specified then white space is removed
  309. (spaces, tabs, newlines, and carriage returns).
  310.  
  311. .SH KEYWORDS
  312. case conversion, compare, index, match, pattern, string
  313.